org.eclipse.vtp.framework.interactions.core.platforms
Interface IDocument

All Known Implementing Classes:

ControllerDocument, RawDocument, VXMLDocument, WidgetDocument

public interface IDocument

This interface represents an abstract document that can be represented in an XML structure.

Version:

1.0

Author:

Lonnie Pryor

Field Summary

static java.lang.String

DEFAULT_CONTENT_TYPE The daefualt content type (text/xml).

Method Summary

java.lang.String	getContentType() Returns a string representing the MIME type of XML document this instance produces.
java.lang.String	getDocumentType() Returns a string representing the dialect of XML document this instance produces.
javax.xml.transform.Source	toXMLSource() Creates and returns an XML representation of this document.

Field Detail

DEFAULT_CONTENT_TYPE

static final java.lang.String DEFAULT_CONTENT_TYPE

The daefualt content type (text/xml).

See Also:

Constant Field Values

Method Detail

getDocumentType

java.lang.String getDocumentType()

Returns a string representing the dialect of XML document this instance produces.

Returns:

A string representing the dialect of XML document this instance produces.

getContentType

java.lang.String getContentType()

Returns a string representing the MIME type of XML document this instance produces.

Returns:

A string representing the MIME type of XML document this instance produces.

toXMLSource

javax.xml.transform.Source toXMLSource()
                                       throws java.lang.IllegalStateException

Creates and returns an XML representation of this document.

Returns:

An XML transformation source object that can be used with the javax.xml.transform API.

Throws:

java.lang.IllegalStateException - If any aspect of this document's state prevents it from being transformed into XML.